home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / VIRUS / PKINS51.ARJ / PKINSERT.DOC < prev    next >
Text File  |  1991-04-27  |  16KB  |  528 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                                 P K I N S E R T
  26.                                   Version 5.1
  27.  
  28.                     Copyright 7th ILLUSION Enrg., 1990-1991
  29.                               All Rights Reserved
  30.                              Released April 27, 1991
  31.                                 F R E E W A R E
  32.  
  33.  
  34.  
  35.  
  36.  
  37.                                7th ILLUSION Enrg.
  38.                               Post Office Box 1334
  39.                                    Station H
  40.                                 Montreal, Quebec
  41.                                      Canada
  42.                                     H3G-2N6
  43.  
  44.                                  (514)523-2387
  45.                        USRobotics Courier HST 14,400 Bps
  46.  
  47.      
  48.  
  49.      ──────────────────────────────────────────────────────────────────────
  50.      PKinsert v5.1                                   Software Documentation
  51.      ──────────────────────────────────────────────────────────────────────
  52.  
  53.      Using  the  simplest configuration,  PKinsert  will let  you  insert a
  54.      comment to a range  of archives.  Other features  which may be toggled
  55.      include an integrity test,  virus scan, disclaimer file insert/delete,
  56.      and full activity logging.
  57.  
  58.      No registration fees  are needed to  use PKinsert.  Drop  me a line if
  59.      you have any suggestions or (gasp) bug reports.
  60.  
  61.  
  62.  
  63.                                                J.S. Morisset
  64.                                                A.k.a. Storm widow
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.      ──────────────────────────────────────────────────────────────────────
  106.                                                                     Page 1
  107.      
  108.  
  109.      ──────────────────────────────────────────────────────────────────────
  110.      PKinsert v5.1                                   Software Documentation
  111.      ──────────────────────────────────────────────────────────────────────
  112.  
  113.                                   REQUIREMENTS
  114.  
  115.      PKinsert  has been  tested with  Microsoft  DOS v3.3/4.01  (French and
  116.      English) and  Digital Research DOS  v5.0.  PKinsert may  abort if used
  117.      from other operating systems or shells.
  118.  
  119.      You must have (FILES=10) or more in your CONFIG.SYS.
  120.  
  121.      Your PATH setting should include the following files ...
  122.  
  123.          PKZIP.EXE
  124.          PKUNZIP.EXE - Archive  utility  from  PKWARE  Inc.   Available for
  125.                        download as PKZxxx.ZIP
  126.          SCAN.EXE    - Virus Scanner from McAfee Associates.  Available for
  127.          (optional)    download as SCANVxx.ZIP.
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.      ──────────────────────────────────────────────────────────────────────
  166.                                                                     Page 2
  167.      
  168.  
  169.      ──────────────────────────────────────────────────────────────────────
  170.      PKinsert v5.1                                   Software Documentation
  171.      ──────────────────────────────────────────────────────────────────────
  172.  
  173.                               CONFIGURING PKINSERT
  174.  
  175.      Copy all the files from this  archive to a permanent directory such as
  176.      C:\PKINSERT.  You may, of course,  use any other directory name and/or
  177.      drive.
  178.  
  179.      In order for PKinsert to locate  it's configuration file we must point
  180.      it in the right direction.
  181.  
  182.          Environment Variable
  183.          ────────────────────
  184.          From the DOS  prompt or a  batch file (usually  autoexec), use the
  185.          command ...
  186.  
  187.               SET PKINSERT=(config name & path)
  188.               C:\>SET PKINSERT=C:\PKINSERT\PKINSERT.CFG
  189.  
  190.          Command Line
  191.          ────────────
  192.          or, enter  the path  to your  configuration file  from the command
  193.          line using the (/) switch.
  194.  
  195.               PKINSERT /(config name & path)
  196.               C:\> PKINSERT AU*.ZIP /D:\PKINSERT\NODE1.CFG A10-?.ZIP
  197.                                     ^^^^^^^^^^^^^^^^^^^^^^
  198.  
  199.      Call up PKinsert using the (/C)onfig  command line switch.  Use one of
  200.      the following methods ...
  201.  
  202.        * PKINSERT /C
  203.          (PKinsert will ask for path and file name of configuration file)
  204.  
  205.          C:\> PKINSERT /C:\PKINSERT\NODE1.CFG /C
  206.  
  207.          C:\> SET PKINSERT=C:\PKINSERT\PKINSERT.CFG
  208.          C:\> PKINSERT /C
  209.  
  210.      PKinsert will  ask you  a few questions  and then  optionally save the
  211.      results.  All the questions  are fairly wordy so  later you won't have
  212.      to pull out the manual every time you want to change something.
  213.  
  214.      Work drive
  215.      ──────────
  216.      You can  double the speed  of PKinsert  by using a  RAM-Disk!  If not,
  217.      just enter  the drive letter  to your fastest  Hard-Drive.  This drive
  218.      should be big enough to extract your biggest archive.
  219.  
  220.      Wildcard - calling PKinsert without parameters
  221.      ──────────────────────────────────────────────
  222.      Usually, you'll be passing PKinsert  archive names through the command
  223.      line.  But for those  'on the fly' jobs,  you can simply type PKINSERT
  224.  
  225.      ──────────────────────────────────────────────────────────────────────
  226.                                                                     Page 3
  227.      
  228.  
  229.      ──────────────────────────────────────────────────────────────────────
  230.      PKinsert v5.1                                   Software Documentation
  231.      ──────────────────────────────────────────────────────────────────────
  232.  
  233.      and let 'er go.  PKinsert will process files which match this filespec
  234.      in the  current directory.   Usually you  will want  to leave  this at
  235.      (*.ZIP) but in case  you don't follow the standard  of ZIP or insert a
  236.      set or archives quite frequently, I've left it open to change.
  237.  
  238.        * PKINSERT
  239.          C:\> PKINSERT *.ZIP
  240.          C:\> PKINSERT *.ZIP /C:\PKINSERT\NODE1.CFG
  241.          C:\> PKINSERT /C:\PKINSERT\PKINSERT.CFG
  242.  
  243.      Test Archives
  244.      ─────────────
  245.      To save time  PKinsert only checks an  archives integrity once, before
  246.      doing  anything else.   If  you're positive  PKinsert  won't encounter
  247.      corrupted archives you can set  this to (N)o.  Processing bad archives
  248.      will have no effect on PKinsert.
  249.  
  250.      Check Archives for Viruses
  251.      ──────────────────────────
  252.      PKinsert can use SCAN.EXE  from McAfee Associates.  You  can pick up a
  253.      copy from almost any good board as SCANVxx.ZIP.
  254.  
  255.      Those of you without the luxury of a Ram Disk might find this a little
  256.      disk intensive.
  257.  
  258.      PKINSERT.DAT (archive comment) File
  259.      ───────────────────────────────────
  260.      The PKINSERT.DAT file can  be changed to your  liking.  This text file
  261.      will be inserted as the archives 'opening screen'.
  262.  
  263.      A couple of notes on it's conception.  I don't recommend you use  ANSI
  264.      codes, most users don't know about PKZIPs (-q) switch.  If you make it
  265.      longer than 23 lines it'll probably flash by too fast to read.
  266.  
  267.      Be  as creative  as  you want.   SysOps  always enjoy  a  good graphic
  268.      competition.  (grin)
  269.  
  270.      Delete Disclaimer Files
  271.      ───────────────────────
  272.      PKinsert will  optionally delete  disclaimer files  from other boards.
  273.      If you choose to use this  option, create an ASCII file which contains
  274.      a list of filespecs  to delete from archives.   Wildcarding is OK.  If
  275.      you're having problems with  the concept, look up  the (@) variable in
  276.      PKzip's manual.
  277.  
  278.        * C:\PKINSERT\PKINSERT.DEL
  279.  
  280.          Contents ->    !HIS*.DIS
  281.                         AAX*.HIS
  282.                         !README.DIS
  283.                         !*.???
  284.  
  285.      ──────────────────────────────────────────────────────────────────────
  286.                                                                     Page 4
  287.      
  288.  
  289.      ──────────────────────────────────────────────────────────────────────
  290.      PKinsert v5.1                                   Software Documentation
  291.      ──────────────────────────────────────────────────────────────────────
  292.  
  293.  
  294.      Be careful of the filespecs you enter in this list.  In one archive it
  295.      might  be  a BBS  disclaimer,  in  another it  could  be  an important
  296.      documentation file.
  297.  
  298.      Insert Disclaimer in Archive
  299.      ────────────────────────────
  300.      PKinsert  let's  you  add  a  Disclaimer  file  to  every  archive  it
  301.      processes.  An extension of DIS is usually preferred by everyone.
  302.  
  303.      Please  note that  this is  not a  recommended practice.   Users might
  304.      complain about the size and  cluttering of archives.  I've come across
  305.      archives which had five disclaimer  files!  All of which where useless
  306.      BBS adds.
  307.  
  308.      Activity Logging
  309.      ────────────────
  310.      Just in case ....  PKinsert will report the status of every archive it
  311.      processes.   This is  a good  way to  find out  how many  corrupted or
  312.      virused archives you receive.
  313.  
  314.      When  activity  logging  is  on,  PKinsert  will  not  pause  when  it
  315.      encounters corrupted or virused archives.
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.      ──────────────────────────────────────────────────────────────────────
  346.                                                                     Page 5
  347.      
  348.  
  349.      ──────────────────────────────────────────────────────────────────────
  350.      PKinsert v5.1                                   Software Documentation
  351.      ──────────────────────────────────────────────────────────────────────
  352.  
  353.                                  USING PKINSERT
  354.  
  355.      There are only a few ways to call up PKinsert ...  If you run PKinsert
  356.      without command  line options, it  will use the  wildcard filespec you
  357.      entered  earlier.  Usually,  you will  specify  the files  to process.
  358.      Following are a few examples ...
  359.  
  360.          C:\> PKINSERT *.zip
  361.          C:\> PKINSERT
  362.          C:\> PKINSERT testzip1.* game???.* selfex.exe *-2.* d:\min\t1*.2??
  363.          C:\> PKINSERT f:\arc\123.*
  364.  
  365.      In those cases PKinsert would have looked for the PKINSERT environment
  366.      variable to locate it's configuration file.   If you are not using the
  367.      PKINSERT environment variable, or would  like to over-ride it, use the
  368.      (/)  command line  switch.   Here are  some  more examples  using this
  369.      method ....
  370.  
  371.          C:\> PKINSERT *.zip /c:\personal\me.cfg
  372.          C:\> PKINSERT /d:\board\node1.cnf
  373.          C:\> PKINSERT /d:\board\node1.cnf c:\arc\*.zip d:\work\*.zip
  374.  
  375.      That's  about  all there  is  to  it.  If  you've  configured PKinsert
  376.      properly you should have no problems.
  377.  
  378.                                   ODDS & ENDS
  379.  
  380.      PCBoard SysOps using ProDoor might be aware of the TAGLINE environment
  381.      variable.  This variable's value is attached at the bottom of messages
  382.      left in ProDoor.  Several utilities  for PCBoard have been released to
  383.      cycle  taglines.  Running  PKinsert  with this  variable  active, will
  384.      cause it to tag  archive comments.  PKinsert limits  it's length to 58
  385.      characters.
  386.  
  387.          C:\> SET TAGLINE=This is a funny little saying/signature ...
  388.  
  389.      When using the virus scan option you will notice that an extra line is
  390.      added to  your archive comment  notifying users that  this archive was
  391.      checked.  You may  expand this comment  to include the  version of the
  392.      scanner you used.
  393.  
  394.          C:\> SET SCAN=6.3V72
  395.  
  396.      The (/) command line option, which specifies the path and file name of
  397.      the configuration file,  overrides the environment  variable.  You can
  398.      use this  to your  advantage by keeping  a configuration  file for the
  399.      board (using command  line) and one  for yourself (using environment).
  400.      The BBS might  use all of  PKinserts options while  you would only use
  401.      the comment insert function.
  402.  
  403.      PKinsert is meant  to run as a  BBS utility.  As  such it should NEVER
  404.  
  405.      ──────────────────────────────────────────────────────────────────────
  406.                                                                     Page 6
  407.      
  408.  
  409.      ──────────────────────────────────────────────────────────────────────
  410.      PKinsert v5.1                                   Software Documentation
  411.      ──────────────────────────────────────────────────────────────────────
  412.  
  413.      beep.   There  are  however  some  exceptions  ....   1  BEEP  signals
  414.      detection of a  virus, 2 BEEPS  means an error  occurred with PKinsert
  415.      which  was  not controlled.   If  this happens  you  should DEFINITELY
  416.      report it.
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.      ──────────────────────────────────────────────────────────────────────
  466.                                                                     Page 7
  467.      
  468.  
  469.      ──────────────────────────────────────────────────────────────────────
  470.      PKinsert v5.1                                   Software Documentation
  471.      ──────────────────────────────────────────────────────────────────────
  472.  
  473.                                 PKINSERT HISTORY
  474.  
  475.                                   Version 3.1ß
  476.  
  477.      Got rid of a few bugs.  The timer feature in v3.0 wasn't working and I
  478.      got  rid of  it.   Also shortened  much  of PKinsert's  output.  Error
  479.      trapping is also much improved!  Let's hope it won't need it.  <Ugg>
  480.  
  481.                                   Version 3.20
  482.  
  483.      Added  support  for  DOSv4.0.    Uses  prodoor's  TAGLINE  environment
  484.      variable.  Will now skip the archive test if set to [N]o.
  485.  
  486.                                   Version 4.00
  487.  
  488.      PKinsert now works  with DOS4! ;-)  Corrupted  archives are caught and
  489.      renamed.   Virus checking  is also  possible using  McAfee Associates'
  490.      SCAN.EXE program.  Work  drive can be  selected for quicker processing
  491.      on  a RAM  Drive.   Configuration is  now  internal.  No  more messin'
  492.      around with a  word processor.  And  last but not  least PKinsert goes
  493.      COLOUR!
  494.  
  495.                                   Version 4.02
  496.  
  497.      Fixed the  colours in  PKinserts logo.   Also fixed  a variable  I had
  498.      forgotten about.  PKinsert will now process numerous file specs again!
  499.      <Grin>.  PKTMP environment variable is now external.
  500.  
  501.                                   Version 5.0
  502.  
  503.      10k Smaller and much faster!  New features include ...
  504.  
  505.      - Random work directory names.
  506.      - 0 byte files are no longer processed.
  507.      - Complete activity logging to disk.
  508.      - All options can be toggled on or off.
  509.      - Configuration path may be entered by environment variable or command
  510.        line.
  511.      - Various configuration file names may be used.
  512.      - PKinsert will change  drives and directories  as it handles archives
  513.        for shorter DOS commands.
  514.      - PKinsert may add the virus scanner version to the archive comment.
  515.      - Compatible with  Digital Research  DOS 5.0  (actually, this  is what
  516.        prompted this new release).
  517.  
  518.                                   Version 5.1
  519.  
  520.      Fixed an incompatibility problem with COUNTRY.SYS.  Thanks to Yan Wolf
  521.      from Top 50  BBS in Paris, France  for his help  in tracking down this
  522.      problem.
  523.  
  524.  
  525.      ──────────────────────────────────────────────────────────────────────
  526.                                                                     Page 8
  527.      
  528.